home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / telegard / tgfpu300.zip / TGFAL.DOC < prev    next >
Text File  |  1996-01-20  |  8KB  |  253 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                                  TGFAL
  18.                    =================================
  19.                     Version 3.00 - January 20, 1996
  20.  
  21.  
  22.                        Telegard File Area Lister
  23.                                 for the
  24.                         Telegard 3.0 BBS system
  25.  
  26.  
  27.  
  28.                           Mt. Glacier Software
  29.               Copyright (c) 1992, 1996 by Michael G. Smith
  30.                           All rights reserved.
  31.  
  32.  
  33.  
  34.             Latest version and Support available on my BBS:
  35.  
  36.                            The Twilight Zone
  37.                            Telegard Beta Site
  38.                              (203)688-0675
  39.  
  40.                            FidoNet  1:142/550
  41.                             ITCNET 85:861/101
  42.       2400-33,600/V.32/V.34/V.FC HST Dual Standard (v.Everything)
  43.                (FREQ magic name TGFPU for latest version)
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                         Purpose and Capabilities
  70.                         ========================
  71.  
  72.     This utility program will output the file names of all defined file
  73.     areas in a Telegard system.  This is useful to create a list that can
  74.     then be edited, sorted, or whatever.  The final file could then, for
  75.     example, be included in a DOS batch file (or equivalent) that could be
  76.     used for file maintenance.
  77.  
  78.     The utility takes as a single argument the desired output filename.
  79.  
  80.     If desired, a prefix and/or suffix string can be specified which will
  81.     be included in the output line before/after the file name.
  82.  
  83.     By default, the utility creates the output file (overwriting any
  84.     existing file).  Optionally, the output file can be appended to.
  85.  
  86.  
  87.                                 Warranty
  88.                                 ========
  89.  
  90.     This product is provided "as is" without warranty of any kind. The entire
  91.     risk as to the results and  performance of the program is assumed by you.
  92.     Furthermore, the  author does  not warrant, guarantee, or  make any  other
  93.     representations regarding  the use of,  or the  results of the use of the
  94.     program,  and you  rely on the  program and  results  solely at  your own
  95.     risk.  The author  cannot and  will not accept  responsibility for system
  96.     damage, loss of profit, or any other special, consequential or incidental
  97.     damages  resulting  from  the  use  or  inability  to  use this  product.
  98.  
  99.     I've tested it on my system and it's worked fine.  If you do find any
  100.     bugs, please report them using one of the support options below.
  101.  
  102.  
  103.                                Copyright
  104.                                =========
  105.  
  106.     TGFAL is Copyright (c) 1996 Mt. Glacier Software by Michael G. Smith.
  107.     It is distributed as Freeware.  You are encouraged to use  this utility
  108.     free of  charge.  Any comments/feedback/suggestions would be gladly
  109.     accepted (see Support section below), including a simple note to say
  110.     "Thanks".
  111.  
  112.  
  113.                               Distribution
  114.                               ============
  115.  
  116.     You are encouraged to distribute TGFAL provided that all files contained
  117.     in the archive are distributed in their original and unmodified state.
  118.     No fee is to be charged above a normal minimal distribution fee.
  119.  
  120.  
  121.                               Description
  122.                               ===========
  123.  
  124.     TGFAL is a little utility program I wrote to "front end" the creation of
  125.     a batch file for use in running TGFPU and other utilities.  It simply
  126.     outputs to the output file specified each and every 'filename' you've
  127.     specified when creating your file areas in the Telegard File Area
  128.     Manager.
  129.  
  130.     TGFAL locates and extracts its information from the FAREAS.DAT file in
  131.     the Telegard \DATA directory.
  132.  
  133.  
  134.                             Important Notes
  135.                             ===============
  136.  
  137.     1. Option switches can be specified with slash or dash (e.g. /B or -B).
  138.  
  139.     2. If /A (Append) is specified, the output file is appended to if it
  140.        exists in the current directory, otherwise the file is created as new.
  141.  
  142.     3. Arguments to the /P (Prefix) and /S (Suffix) should use an underscore
  143.        "_" character to represent a space.   If you need to have an
  144.        underscore in the output file, you'll need to edit and place it there
  145.        yourself - sorry.
  146.  
  147.     4. Output line length is limited to 80 characters total.
  148.  
  149.  
  150.                                  Usage
  151.                                  =====
  152.  
  153.     TGFAL will attempt to open CONFIG.TG in the current directory, and if not
  154.     found, will search the DOS PATH for it.  Successful completion returns a
  155.     zero condition code, any errors will produce a non-zero return code.
  156.     Return codes (errorlevels) are detailed below.
  157.  
  158.     TGFAL accepts one command line parameter (which is required),
  159.     and up to three command line option switches (which are optional).
  160.  
  161.     Command format is:
  162.  
  163.       TGFAL outfile [/A] [/Pprefix] [/Ssuffix]
  164.  
  165.     Where:
  166.  
  167.        outfile - Specifies the output filename to create/append.
  168.  
  169.             /A  - Specify to append to output file.
  170.  
  171.        /Pprefix - Specify to add a prefix string to each output line.
  172.                   Do not leave a space between the /P and the prefix string.
  173.                   If spaces are desired, use an underscore (_) in their
  174.                   place.
  175.  
  176.        /Psuffix - Specify to add a suffix string to each output line.
  177.                   Do not leave a space between the /S and the suffix string.
  178.                   If spaces are desired, use an underscore (_) in their
  179.                   place.
  180.  
  181.  
  182.     Example commands:
  183.  
  184.        TGFAL FILES.LST      =  Output to file FILES.LST in the current
  185.                                directory a list of the defined file names
  186.                                in the FAREAS.DAT file.  If FILES.LST exists,
  187.                                it will be over written.
  188.  
  189.        TGFAL RUNTGFPU.BAT /PTGFPU /S1
  190.                             =  Output to file RUNTGFPU.BAT in the current
  191.                                directory a list of the defined file names
  192.                                in the FAREAS.DAT file.  If RUNTGFPU.BAT
  193.                                exists it will be over written. The prefix
  194.                                TGFPU and the suffix "1" will be added to
  195.                                the output file.
  196.  
  197.  
  198.  
  199.  
  200.                       Return Codes / ErrorLevels
  201.                       ==========================
  202.  
  203.      0 = Normal completion.
  204.      4 = Invalid or Missing Parameters.
  205.      8 = Error Opening or Reading CONFIG.TG file.
  206.     12 = Error Opening or Reading FAREAS.DAT file.
  207.     16 = Error Opening or Writing specified output file.
  208.  
  209.  
  210.                                 Support
  211.                                 =======
  212.  
  213.     I can be reached at the following for support/questions/suggestions about
  214.     this utility (listed in my preferred order):
  215.  
  216.        FIDO:  1:142/550 (FREQ magic name TGFPU for latest version)
  217.      ITCNET: 85:861/101
  218.              Use NetMail for fastest reply.
  219.  
  220.     BBS:  The Twilight Zone
  221.           Telegard Beta Site
  222.           (203)688-0675   HST Dual Standard (v.Everything)
  223.  
  224.     U.S. Mail:  Michael G. Smith
  225.                 14 Oxford Lane
  226.                 Windsor, CT  06095
  227.  
  228.     Phone:      Sorry. No voice support available.
  229.  
  230.  
  231.                                 History
  232.                                 =======
  233.  
  234.     Version    Date     Remarks
  235.     -------    ----     -------
  236.      3.00    11/20/96   Initial version. Distributed in TGFPU300.ZIP.
  237.  
  238.  
  239.                         Futures and Enhancements
  240.                         ========================
  241.  
  242.     Well, that all depends.  If I get some positive feedback on this utility,
  243.     requesting worthwhile enhancements, I'll consider updating it.  If not,
  244.     well... it does what I want right now.  :)
  245.  
  246.     Some possibilities: (suggestions cheerfully accepted)
  247.  
  248.     - Accomodate underscores in output line.
  249.  
  250.     - ???
  251.  
  252.                      -= End of TGFAL.DOC file =-
  253.